| Package | hl7.fhir.us.davinci-vbpr |
| Type | CapabilityStatement |
| Id | Id |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/davinci-vbpr/https://build.fhir.org/ig/HL7/davinci-vbpr/CapabilityStatement-vbp-reporting-client.html |
| Url | http://hl7.org/fhir/us/davinci-vbpr/CapabilityStatement/vbp-reporting-client |
| Version | 1.0.0 |
| Status | active |
| Date | 2024-04-25 |
| Name | VBPReportingClientCapabilityStatement |
| Title | VBP Reporting Client Capability Statement |
| Experimental | False |
| Realm | us |
| Authority | hl7 |
| Description | This profile defines the expected capabilities of the Value-Based Performance (VBP) Reporting Client actor, when request and consume value-based performance MeasureReports from a Value-Based Performance Reporting Server. The complete list of FHIR profiles that a VBP Reporting Server could support are defined. VBP Reporting Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements. |
| Kind | requirements |
No resources found
| ImplementationGuide | |
http://hl7.org/fhir/us/davinci-deqm/ImplementationGuide/hl7.fhir.us.davinci-deqm  | Data Exchange For Quality Measures Implementation Guide |
| http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures | Quality Measure Implementation Guide (STU5) |
| http://hl7.org/fhir/us/davinci-vbpr/SearchParameter/measurereport-category | MeasureReportCategory |
| http://hl7.org/fhir/us/davinci-vbpr/SearchParameter/measurereport-subject-organization | MeasureReportSubjectOrganization |
| http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-measure | Value-Based Performance Measure |
| http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-performance-measurereport | Value-Based Performance MeasureReport |
| http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-quality-measurereport | VBP Quality MeasureReport |
Note: links and images are rebased to the (stated) source
FHIRxml, jsonapplication/json-patch+jsonNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
clientDa Vinci Value-Based Performance Reporting Server SHALL support the profiles specified in this implementation guide.
For general security consideration refer to the Security and Privacy Considerations.
batchinteraction.transactioninteraction.search-systeminteraction.history-systeminteraction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | V-R | S | U | C | H-I | H-T | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Measure | http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-measure | y | y | y | y | y | ||||||
| MeasureReport | Supported Profiles Value-Based Performance MeasureReport VBP Quality MeasureReport | y | y | y | y | y | date, evaluatedResource, identifier, measure, patient, period, reporter, status, subject, measurereport-category, measurereport-subject-organization | MeasureReport.evaluatedResources |
read, history-instance, search-type.vread, history-type.literal, logicalread, history-instance, search-type.vread, history-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | date | date | |
| SHALL | evaluatedResource | reference | |
| SHALL | identifier | token | |
| SHALL | measure | reference | |
| SHALL | patient | reference | |
| SHALL | period | date | |
| SHALL | reporter | reference | |
| SHALL | status | token | |
| SHALL | subject | reference | |
| SHALL | measurereport-category | string | |
| SHALL | measurereport-subject-organization | reference |
{
"resourceType" : "CapabilityStatement",
"id" : "vbp-reporting-client",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">VBP Reporting Client Capability Statement</h2><ul><li>Implementation Guide Version: 1.0.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: <code>application/json-patch+json</code></li><li>Published on: 2024-04-25 </li><li>Published by: HL7 International / Clinical Quality Information </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id=\"shallIGs\">SHALL Support the Following Implementation Guides</h3><ul><li><a href=\"http://hl7.org/fhir/us/davinci-deqm/STU3.1/ImplementationGuide-hl7.fhir.us.davinci-deqm.html\">http://hl7.org/fhir/us/davinci-deqm/ImplementationGuide/hl7.fhir.us.davinci-deqm</a></li><li><a href=\"http://hl7.org/fhir/us/cqfmeasures/STU3/ImplementationGuide-hl7.fhir.us.cqfmeasures.html\">http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures</a></li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h3></div><div class=\"panel-body\"><div><p>Da Vinci Value-Based Performance Reporting Server <strong>SHALL</strong> support the profiles specified in this implementation guide.</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>For general security consideration refer to the <a href=\"http://hl7.org/fhir/R4/secpriv-module.html\">Security and Privacy Considerations</a>.</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li><strong>SHOULD</strong>Supports the <code>batch</code>interaction.</li><li><strong>SHOULD</strong>Supports the <code>transaction</code>interaction.</li><li><strong>MAY</strong>Supports the <code>search-system</code>interaction.</li><li><strong>MAY</strong>Supports the <code>history-system</code>interaction.</li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET past versions of resources (vread interaction)\">V-R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th class=\"text-center\"><b title=\"GET changes to a resource (history interaction on instance)\">H-I</b></th><th class=\"text-center\"><b title=\"GET changes for all resources of the type (history interaction on type)\">H-T</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Measure1-1\">Measure</a></td><td><a href=\"StructureDefinition-vbp-measure.html\">http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-measure</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#MeasureReport1-2\">MeasureReport</a></td><td>Supported Profiles<br/>��<a href=\"StructureDefinition-vbp-performance-measurereport.html\">Value-Based Performance MeasureReport</a><br/>��<a href=\"StructureDefinition-vbp-quality-measurereport.html\">VBP Quality MeasureReport</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>date, evaluatedResource, identifier, measure, patient, period, reporter, status, subject, measurereport-category, measurereport-subject-organization</td><td><code>MeasureReport.evaluatedResources</code></td><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Measure1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: MAY </span>Measure</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-vbp-measure.html\">http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-measure</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong>support <code>read</code>, <code>history-instance</code>, <code>search-type</code>.</li><li><strong>MAY</strong>support <code>vread</code>, <code>history-type</code>.</li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"MeasureReport1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>MeasureReport</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/measurereport.html\">MeasureReport</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code>, <code>logical</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong>support <code>read</code>, <code>history-instance</code>, <code>search-type</code>.</li><li><strong>MAY</strong>support <code>vread</code>, <code>history-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-vbp-performance-measurereport.html\">http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-performance-measurereport</a><br/><a href=\"StructureDefinition-vbp-quality-measurereport.html\">http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-quality-measurereport</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/measurereport.html#search\">date</a></td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/measurereport.html#search\">evaluatedResource</a></td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/measurereport.html#search\">identifier</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/measurereport.html#search\">measure</a></td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/measurereport.html#search\">patient</a></td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/measurereport.html#search\">period</a></td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/measurereport.html#search\">reporter</a></td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/measurereport.html#search\">status</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/measurereport.html#search\">subject</a></td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-measurereport-category.html\">measurereport-category</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-measurereport-subject-organization.html\">measurereport-subject-organization</a></td><td><code>reference</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cqi"
}
],
"url" : "http://hl7.org/fhir/us/davinci-vbpr/CapabilityStatement/vbp-reporting-client",
"version" : "1.0.0",
"name" : "VBPReportingClientCapabilityStatement",
"title" : "VBP Reporting Client Capability Statement",
"status" : "active",
"experimental" : false,
"date" : "2024-04-25",
"publisher" : "HL7 International / Clinical Quality Information",
"contact" : [
{
"name" : "HL7 International / Clinical Quality Information",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/cqi"
}
]
}
],
"description" : "This profile defines the expected capabilities of the Value-Based Performance (VBP) Reporting Client actor, when request and consume value-based performance MeasureReports from a Value-Based Performance Reporting Server. The complete list of FHIR profiles \r\nthat a VBP Reporting Server could support are defined. VBP Reporting Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"xml",
"json"
],
"patchFormat" : [
"application/json-patch+json"
],
"implementationGuide" : [
"http://hl7.org/fhir/us/davinci-deqm/ImplementationGuide/hl7.fhir.us.davinci-deqm",
"http://hl7.org/fhir/us/cqfmeasures/ImplementationGuide/hl7.fhir.us.cqfmeasures"
],
"rest" : [
{
"mode" : "client",
"documentation" : "Da Vinci Value-Based Performance Reporting Server **SHALL** support the profiles specified in this implementation guide.",
"security" : {
"description" : "For general security consideration refer to the [Security and Privacy Considerations](http://hl7.org/fhir/R4/secpriv-module.html)."
},
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"type" : "Measure",
"profile" : "http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-measure",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read allows maintainers of the Measures to get the logical definitions of the Measure"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Search allows maintainers of the Measures to find the logical definition of a Measure"
}
]
},
{
"type" : "MeasureReport",
"supportedProfile" : [
"http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-performance-measurereport",
"http://hl7.org/fhir/us/davinci-vbpr/StructureDefinition/vbp-quality-measurereport"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read allows maintainers of the MeasureReports to get the logical definitions of the MeasureReports"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Search allows maintainers of the MeasureReports to find the logical definition of a MeasureReport"
}
],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"conditionalDelete" : "multiple",
"referencePolicy" : [
"literal",
"logical"
],
"searchInclude" : [
"MeasureReport.evaluatedResources"
],
"searchParam" : [
{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-date",
"type" : "date"
},
{
"name" : "evaluatedResource",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-evaluated-resource",
"type" : "reference"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-identifier",
"type" : "token"
},
{
"name" : "measure",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-measure",
"type" : "reference"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-patient",
"type" : "reference"
},
{
"name" : "period",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-period",
"type" : "date"
},
{
"name" : "reporter",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-reporter",
"type" : "reference"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-status",
"type" : "token"
},
{
"name" : "subject",
"definition" : "http://hl7.org/fhir/SearchParameter/MeasureReport-subject",
"type" : "reference"
},
{
"name" : "measurereport-category",
"definition" : "http://hl7.org/fhir/us/davinci-vbpr/SearchParameter/measurereport-category",
"type" : "string"
},
{
"name" : "measurereport-subject-organization",
"definition" : "http://hl7.org/fhir/us/davinci-vbpr/SearchParameter/measurereport-subject-organization",
"type" : "reference"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "batch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "transaction"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-system"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-system"
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.